Skip to content

Extended map to support geo location entities#2337

Merged
balloob merged 6 commits into
home-assistant:devfrom
exxamalte:geo-location-map
Dec 17, 2018
Merged

Extended map to support geo location entities#2337
balloob merged 6 commits into
home-assistant:devfrom
exxamalte:geo-location-map

Conversation

@exxamalte
Copy link
Copy Markdown
Contributor

@exxamalte exxamalte commented Dec 16, 2018 •
edited
Loading

This is an extension to the lovelace map card that can not only display manually configured entities, but allows for configuring a geo_location_sources array; each geo location platform defines its source. All current geo location entities with that source will be displayed on the map automatically.
Either entities or geo_location_sources is required; if geo_location_sources is defined, then entities is optional.

Sample card configuration:

type: map
geo_location_sources:
  - nsw_rural_fire_service_feed
entities:
  - zone.home
default_zoom: 9

lovelace-geo-location-map

Pull request in home-assistant.io: home-assistant/home-assistant.io#7880

@ghost ghost added the in progress label Dec 16, 2018
@exxamalte
Copy link
Copy Markdown
Contributor Author

exxamalte commented Dec 16, 2018

Hold on, I just realised that entities is required, but instead source should be required and entities optional.

@iantrich
Copy link
Copy Markdown
Member

iantrich commented Dec 16, 2018

We have a map card. Why would you not at least add this source to the existing rather than copy all its code to a new file to add it?

@exxamalte
Copy link
Copy Markdown
Contributor Author

exxamalte commented Dec 16, 2018 •
edited
Loading

Sure, happy to do that as well. I'm just wondering how to untangle which config parameters are then required and which ones are optional: The default map requires entities to be set, while the geo location map requires source to be set and additional entities are optional.

How about: If source is set, then entities are optional?

@exxamalte
Copy link
Copy Markdown
Contributor Author

exxamalte commented Dec 16, 2018 •
edited
Loading

Alright, I merged the geo location code into the existing map.

Sorry, accidentally closed the PR, reopened straight away...

@exxamalte exxamalte closed this Dec 16, 2018
@ghost ghost removed the in progress label Dec 16, 2018
@exxamalte exxamalte reopened this Dec 16, 2018
@ghost ghost added the in progress label Dec 16, 2018
@exxamalte exxamalte changed the title Geo Location Map Extended map to support geo location entities Dec 16, 2018
@balloob
Copy link
Copy Markdown
Member

balloob commented Dec 16, 2018

Geo location sources should probably be an array?

@exxamalte
Copy link
Copy Markdown
Contributor Author

exxamalte commented Dec 16, 2018

Geo location sources should probably be an array?

Good point, because that would be the only way to join entities from different geo location platforms into one map.

balloob
balloob requested changes Dec 17, 2018
View reviewed changes
Comment thread src/panels/lovelace/cards/hui-map-card.js Outdated
const mapItems = (this._mapItems = []);

this._configEntities.forEach((entity) => {
var allEntities = [];
Copy link
Copy Markdown
Member

@balloob balloob Dec 17, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doing use var

Copy link
Copy Markdown
Contributor Author

@exxamalte exxamalte Dec 17, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, will replace with let

Comment thread src/panels/lovelace/cards/hui-map-card.js Outdated
}

this._configEntities = processConfigEntities(config.entities);
this._configGeoLocationSources = config.geo_location_sources;
Copy link
Copy Markdown
Member

@balloob balloob Dec 17, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't assign before raising errors

Copy link
Copy Markdown
Contributor Author

@exxamalte exxamalte Dec 17, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, moving code around.

@exxamalte exxamalte mentioned this pull request Dec 17, 2018
Merged
2 tasks
@balloob balloob merged commit cac7f8d into home-assistant:dev Dec 17, 2018
@ghost ghost removed the in progress label Dec 17, 2018
@balloob
Copy link
Copy Markdown
Member

balloob commented Dec 17, 2018

Do you want to submit a PR to add this functionality to a map demo ?

@exxamalte
Copy link
Copy Markdown
Contributor Author

exxamalte commented Dec 17, 2018

Do you want to submit a PR to add this functionality to a map demo ?

Sure. I'll take a look at that now...

@exxamalte exxamalte deleted the geo-location-map branch December 17, 2018 11:44
@frenck
Copy link
Copy Markdown
Member

frenck commented Dec 30, 2018

Just a note @exxamalte, geolocation is one word. So, it should be geolocation_sources...

@thomasloven
Copy link
Copy Markdown
Contributor

thomasloven commented Jan 20, 2019

@exxamalte I cannot find any documentation for this. Do you have something prepared, or should I add it when I'm documenting #2489 ?

@exxamalte
Copy link
Copy Markdown
Contributor Author

exxamalte commented Jan 20, 2019

@thomasloven The documentation for this PR can be found here: home-assistant/home-assistant.io#7880

@github-actions github-actions Bot locked and limited conversation to collaborators Jul 7, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@balloob balloob balloob approved these changes

Assignees

No one assigned

Labels

cla-signed Documentation Needed

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@exxamalte @iantrich @balloob @frenck @thomasloven @homeassistant